DOC-585: starting connext version-specific connector-py instructions #192
Conversation
|
|
||
| .. code:: bash | ||
|
|
||
| $ pip install rticonnextdds_connector | ||
|
|
||
| The above command installs the latest version of *Connext* by default. To |
There was a problem hiding this comment.
Obviously, these are not the right instructions. I do not know what the right instructions are. Elaine told me Connector-py needs the same changes that we made to Connector-js and to the Connext Python API regarding versions. So, @Alxe, please tell me what we should really say here (feel free to make changes in the branch if you prefer).
There was a problem hiding this comment.
The pip documentation is accurate, but I'd prefer using rticonnextdds-connector (both are valid) so that it matches JS documentation.
docs/getting_started.rst
Outdated
| @@ -7,21 +7,34 @@ Getting Started | |||
| Installing RTI Connector for Python | |||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |||
|
|
|||
| There are two ways to obtain *RTI Connector* for Python. You can install it with | |||
| *pip*: | |||
| There are two ways to obtain *RTI Connector* for Python: with | |||
There was a problem hiding this comment.
There's only one way. You can no longer clone the Repository.
|
|
||
| .. code:: bash | ||
|
|
||
| $ pip install rticonnextdds_connector | ||
|
|
||
| The above command installs the latest version of *Connext* by default. To |
There was a problem hiding this comment.
The pip documentation is accurate, but I'd prefer using rticonnextdds-connector (both are valid) so that it matches JS documentation.
docs/getting_started.rst
Outdated
| $ pip install rticonnextdds_connector==<version> | ||
|
|
||
| where ``<version>`` is any valid *Connext* version in the | ||
| `Release history <https://pypi.org/project/rti.connext/#history>`__ |
There was a problem hiding this comment.
| `Release history <https://pypi.org/project/rti.connext/#history>`__ | |
| `Release history <https://pypi.org/project/rticonnextdds-connector/#history>`__ |
docs/getting_started.rst
Outdated
| And then run your *Connector* applications: | ||
|
|
||
| .. code:: bash | ||
|
|
||
| $ python my_connector_app.py | ||
|
|
||
| You can also clone the repository and run the examples directly without installing | ||
| *Connector*: | ||
| **To clone the repository and run the examples directly without installing |
There was a problem hiding this comment.
Remove from here until Running the examples.
…n and installation instructions
Link to the output: https://jenkins-community.rti.com/job/ci/job/Connector-PY/job/rticonnextdds-connector-py-doc/view/change-requests/job/PR-192/Connector_20Documentation/